<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Advertising Data Encoder</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51822 BLE SDK
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__ble__sdk__lib__advdata.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Advertising Data Encoder</div>  </div>
<div class="ingroups"><a class="el" href="group__ble__sdk__lib.html">Bluetooth Libraries</a></div></div>
<div class="contents">

<p>Function for encoding the advertising data and/or scan response data, and passing them to the stack.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structble__advdata__uuid__list__t.html">ble_advdata_uuid_list_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">UUID list type.  <a href="structble__advdata__uuid__list__t.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structble__advdata__conn__int__t.html">ble_advdata_conn_int_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection interval range structure.  <a href="structble__advdata__conn__int__t.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structble__advdata__manuf__data__t.html">ble_advdata_manuf_data_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Manufacturer specific data structure.  <a href="structble__advdata__manuf__data__t.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structble__advdata__service__data__t.html">ble_advdata_service_data_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Service data structure.  <a href="structble__advdata__service__data__t.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structble__advdata__t.html">ble_advdata_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Advertising data structure. This contains all options and data needed for encoding and setting the advertising data.  <a href="structble__advdata__t.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ble__sdk__lib__advdata.html#ga03c5ccf232779001be9786021b1a563b">ble_advdata_name_type_t</a> { <a class="el" href="group__ble__sdk__lib__advdata.html#gga03c5ccf232779001be9786021b1a563ba6e99a7c49e28bdae76c43edce53516f7">BLE_ADVDATA_NO_NAME</a>, 
<a class="el" href="group__ble__sdk__lib__advdata.html#gga03c5ccf232779001be9786021b1a563ba28f0d09500400f6210b789bdfe89a0e0">BLE_ADVDATA_SHORT_NAME</a>, 
<a class="el" href="group__ble__sdk__lib__advdata.html#gga03c5ccf232779001be9786021b1a563ba63a26e22b9d6a0899edac755d0e2f488">BLE_ADVDATA_FULL_NAME</a>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Advertising data name type. This contains the options available for the device name inside the advertising data.  <a href="group__ble__sdk__lib__advdata.html#ga03c5ccf232779001be9786021b1a563b">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ble__sdk__lib__advdata.html#ga180ff4057a0763688c734e98ab8d976b">ble_advdata_set</a> (const <a class="el" href="structble__advdata__t.html">ble_advdata_t</a> *p_advdata, const <a class="el" href="structble__advdata__t.html">ble_advdata_t</a> *p_srdata)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes and sets the advertising data and/or scan response data.  <a href="#ga180ff4057a0763688c734e98ab8d976b"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Function for encoding the advertising data and/or scan response data, and passing them to the stack. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga03c5ccf232779001be9786021b1a563b"></a><!-- doxytag: member="ble_advdata.h::ble_advdata_name_type_t" ref="ga03c5ccf232779001be9786021b1a563b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__ble__sdk__lib__advdata.html#ga03c5ccf232779001be9786021b1a563b">ble_advdata_name_type_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Advertising data name type. This contains the options available for the device name inside the advertising data. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga03c5ccf232779001be9786021b1a563ba6e99a7c49e28bdae76c43edce53516f7"></a><!-- doxytag: member="BLE_ADVDATA_NO_NAME" ref="gga03c5ccf232779001be9786021b1a563ba6e99a7c49e28bdae76c43edce53516f7" args="" -->BLE_ADVDATA_NO_NAME</em>&nbsp;</td><td>
<p>Include no device name in advertising data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga03c5ccf232779001be9786021b1a563ba28f0d09500400f6210b789bdfe89a0e0"></a><!-- doxytag: member="BLE_ADVDATA_SHORT_NAME" ref="gga03c5ccf232779001be9786021b1a563ba28f0d09500400f6210b789bdfe89a0e0" args="" -->BLE_ADVDATA_SHORT_NAME</em>&nbsp;</td><td>
<p>Include short device name in advertising data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga03c5ccf232779001be9786021b1a563ba63a26e22b9d6a0899edac755d0e2f488"></a><!-- doxytag: member="BLE_ADVDATA_FULL_NAME" ref="gga03c5ccf232779001be9786021b1a563ba63a26e22b9d6a0899edac755d0e2f488" args="" -->BLE_ADVDATA_FULL_NAME</em>&nbsp;</td><td>
<p>Include full device name in advertising data. </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="ble__advdata_8h_source.html#l00034">34</a> of file <a class="el" href="ble__advdata_8h_source.html">ble_advdata.h</a>.</p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga180ff4057a0763688c734e98ab8d976b"></a><!-- doxytag: member="ble_advdata.h::ble_advdata_set" ref="ga180ff4057a0763688c734e98ab8d976b" args="(const ble_advdata_t *p_advdata, const ble_advdata_t *p_srdata)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t ble_advdata_set </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structble__advdata__t.html">ble_advdata_t</a> *&#160;</td>
          <td class="paramname"><em>p_advdata</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structble__advdata__t.html">ble_advdata_t</a> *&#160;</td>
          <td class="paramname"><em>p_srdata</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Encodes and sets the advertising data and/or scan response data. </p>
<p>This function encodes advertising data and/or scan response data based on the selections in the supplied structures, and passes the encoded data to the stack.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_advdata</td><td>Structure for specifying the content of the advertising data. Set to NULL if advertising data is not to be set. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_srdata</td><td>Structure for specifying the content of the scan response data. Set to NULL if scan response data is not to be set. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NRF_SUCCESS on success, NRF_ERROR_DATA_SIZE if not all the requested data could fit into the advertising packet. </dd></dl>

<p>Definition at line <a class="el" href="ble__advdata_8c_source.html#l00547">547</a> of file <a class="el" href="ble__advdata_8c_source.html">ble_advdata.c</a>.</p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
